

<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
  <meta charset="utf-8">
  
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
  
  <title>GAUsersFetcher &mdash; tdldk  documentation</title>
  

  
  

  

  
  
    

  

  
  
    <link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
  

  

  
    <link rel="top" title="tdldk  documentation" href="../../index.html"/>
        <link rel="up" title="TDLDK API 1.0 Reference" href="../../tdldk_1.0_reference.html"/>
        <link rel="next" title="Bambou API Reference" href="../../bambou_reference.html"/>
        <link rel="prev" title="GATasksFetcher" href="fetchers.gatasksfetcher.html"/> 

  
  <script src="_static/js/modernizr.min.js"></script>

</head>

<body class="wy-body-for-nav" role="document">

  <div class="wy-grid-for-nav">

    
    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
      <div class="wy-side-nav-search">
        

        
          <a href="../../index.html" class="icon icon-home"> tdldk
        

        
          
          <img src="../../_static/logo.png" class="logo" />
        
        </a>

        
<div role="search">
  <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
    <input type="text" name="q" placeholder="Search docs" />
    <input type="hidden" name="check_keywords" value="yes" />
    <input type="hidden" name="area" value="default" />
  </form>
</div>

        
      </div>

      <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
        
          
          
              <ul>
<li class="toctree-l1"><a class="reference internal" href="../../license.html">License</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../general_concepts.html">General Concepts</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../../general_concepts.html#introduction">Introduction</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../general_concepts.html#nurestsession">NURESTSession</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../general_concepts.html#nurestobject">NURESTObject</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../../general_concepts.html#rest-names">ReST Names</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../general_concepts.html#rest-api-uri-generation">ReST API URI Generation</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../general_concepts.html#exposing-rest-attributes">Exposing ReST Attributes</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../general_concepts.html#crud-operations">CRUD Operations</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../general_concepts.html#converting-to-and-from-a-python-dictionary">Converting to and from a Python Dictionary</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../../general_concepts.html#nurestfetcher">NURESTFetcher</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../../general_concepts.html#fetching-children-list">Fetching Children List</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../general_concepts.html#discussion-about-fetchers">Discussion about Fetchers</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../../general_concepts.html#nurestpushcenter">NURESTPushCenter</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../../general_concepts.html#using-the-nurestpushcenter">Using the NURESTPushCenter</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../general_concepts.html#example">Example</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../../general_concepts.html#conclusion">Conclusion</a></li>
</ul>
</li>
</ul>
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="../../tdldk_1.0_reference.html">TDLDK API 1.0 Reference</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="models.galist.html">GAList</a><ul>
<li class="toctree-l3"><a class="reference internal" href="models.galist.html#properties">Properties</a></li>
<li class="toctree-l3"><a class="reference internal" href="models.galist.html#methods">Methods</a></li>
<li class="toctree-l3"><a class="reference internal" href="models.galist.html#inherited-properties">Inherited Properties</a></li>
<li class="toctree-l3"><a class="reference internal" href="models.galist.html#inherited-methods">Inherited Methods</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="models.garoot.html">GARoot</a><ul>
<li class="toctree-l3"><a class="reference internal" href="models.garoot.html#inherited-properties">Inherited Properties</a></li>
<li class="toctree-l3"><a class="reference internal" href="models.garoot.html#inherited-methods">Inherited Methods</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="models.gatask.html">GATask</a><ul>
<li class="toctree-l3"><a class="reference internal" href="models.gatask.html#properties">Properties</a></li>
<li class="toctree-l3"><a class="reference internal" href="models.gatask.html#methods">Methods</a></li>
<li class="toctree-l3"><a class="reference internal" href="models.gatask.html#constants">Constants</a></li>
<li class="toctree-l3"><a class="reference internal" href="models.gatask.html#inherited-properties">Inherited Properties</a></li>
<li class="toctree-l3"><a class="reference internal" href="models.gatask.html#inherited-methods">Inherited Methods</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="models.gatdlsession.html">GATDLSession</a><ul>
<li class="toctree-l3"><a class="reference internal" href="models.gatdlsession.html#properties">Properties</a></li>
<li class="toctree-l3"><a class="reference internal" href="models.gatdlsession.html#methods">Methods</a></li>
<li class="toctree-l3"><a class="reference internal" href="models.gatdlsession.html#inherited-properties">Inherited Properties</a></li>
<li class="toctree-l3"><a class="reference internal" href="models.gatdlsession.html#inherited-methods">Inherited Methods</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="models.gauser.html">GAUser</a><ul>
<li class="toctree-l3"><a class="reference internal" href="models.gauser.html#properties">Properties</a></li>
<li class="toctree-l3"><a class="reference internal" href="models.gauser.html#inherited-properties">Inherited Properties</a></li>
<li class="toctree-l3"><a class="reference internal" href="models.gauser.html#inherited-methods">Inherited Methods</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="models.sdkinfo.html">SDKInfo</a><ul>
<li class="toctree-l3"><a class="reference internal" href="models.sdkinfo.html#methods">Methods</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="fetchers.galistsfetcher.html">GAListsFetcher</a><ul>
<li class="toctree-l3"><a class="reference internal" href="fetchers.galistsfetcher.html#methods">Methods</a></li>
<li class="toctree-l3"><a class="reference internal" href="fetchers.galistsfetcher.html#inherited-properties">Inherited Properties</a></li>
<li class="toctree-l3"><a class="reference internal" href="fetchers.galistsfetcher.html#inherited-methods">Inherited Methods</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="fetchers.gatasksfetcher.html">GATasksFetcher</a><ul>
<li class="toctree-l3"><a class="reference internal" href="fetchers.gatasksfetcher.html#methods">Methods</a></li>
<li class="toctree-l3"><a class="reference internal" href="fetchers.gatasksfetcher.html#inherited-properties">Inherited Properties</a></li>
<li class="toctree-l3"><a class="reference internal" href="fetchers.gatasksfetcher.html#inherited-methods">Inherited Methods</a></li>
</ul>
</li>
<li class="toctree-l2 current"><a class="current reference internal" href="">GAUsersFetcher</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#methods">Methods</a></li>
<li class="toctree-l3"><a class="reference internal" href="#inherited-properties">Inherited Properties</a></li>
<li class="toctree-l3"><a class="reference internal" href="#inherited-methods">Inherited Methods</a></li>
</ul>
</li>
</ul>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../bambou_reference.html">Bambou API Reference</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../../bambou/bambou.bambouconfig.html">BambouConfig</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../../bambou/bambou.bambouconfig.html#methods">Methods</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../../bambou/bambou.nurestconnection.html">NURESTConnection</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../../bambou/bambou.nurestconnection.html#properties">Properties</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../bambou/bambou.nurestconnection.html#methods">Methods</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../../bambou/bambou.nurestfetcher.html">NURESTFetcher</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../../bambou/bambou.nurestfetcher.html#properties">Properties</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../bambou/bambou.nurestfetcher.html#methods">Methods</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../../bambou/bambou.nurestlogincontroller.html">NURESTLoginController</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../../bambou/bambou.nurestlogincontroller.html#properties">Properties</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../bambou/bambou.nurestlogincontroller.html#methods">Methods</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../../bambou/bambou.nurestmodelcontroller.html">NURESTModelController</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../../bambou/bambou.nurestmodelcontroller.html#methods">Methods</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../../bambou/bambou.nurestobject.html">NURESTObject</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../../bambou/bambou.nurestobject.html#properties">Properties</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../bambou/bambou.nurestobject.html#methods">Methods</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../../bambou/bambou.nurestpushcenter.html">NURESTPushCenter</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../../bambou/bambou.nurestpushcenter.html#properties">Properties</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../bambou/bambou.nurestpushcenter.html#methods">Methods</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../../bambou/bambou.nurestrequest.html">NURESTRequest</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../../bambou/bambou.nurestrequest.html#properties">Properties</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../bambou/bambou.nurestrequest.html#methods">Methods</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../../bambou/bambou.nurestresponse.html">NURESTResponse</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../../bambou/bambou.nurestresponse.html#properties">Properties</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../../bambou/bambou.nurestrootobject.html">NURESTRootObject</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../../bambou/bambou.nurestrootobject.html#properties">Properties</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../bambou/bambou.nurestrootobject.html#methods">Methods</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../bambou/bambou.nurestrootobject.html#inherited-properties">Inherited Properties</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../bambou/bambou.nurestrootobject.html#inherited-methods">Inherited Methods</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../../bambou/bambou.nurestsession.html">NURESTSession</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../../bambou/bambou.nurestsession.html#properties">Properties</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../bambou/bambou.nurestsession.html#methods">Methods</a></li>
</ul>
</li>
</ul>
</li>
</ul>

          
        
      </div>
      &nbsp;
    </nav>

    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">

      
      <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
        <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
        <a href="../../index.html">tdldk</a>
      </nav>


      
      <div class="wy-nav-content">
        <div class="rst-content">
          <div role="navigation" aria-label="breadcrumbs navigation">
  <ul class="wy-breadcrumbs">
    <li><a href="../../index.html">Docs</a> &raquo;</li>
      
          <li><a href="../../tdldk_1.0_reference.html">TDLDK API 1.0 Reference</a> &raquo;</li>
      
    <li>GAUsersFetcher</li>
      <li class="wy-breadcrumbs-aside">
        
          
            <a href="../../_sources/tdldk/1.0/fetchers.gausersfetcher.txt" rel="nofollow"> View page source</a>
          
        
      </li>
  </ul>
  <hr/>
</div>
          <div role="main" class="document">
            
  <div class="section" id="gausersfetcher">
<h1>GAUsersFetcher<a class="headerlink" href="#gausersfetcher" title="Permalink to this headline">¶</a></h1>
<dl class="class">
<dt id="tdldk.v1_0.fetchers.GAUsersFetcher">
<em class="property">class </em><code class="descname">GAUsersFetcher</code><a class="reference internal" href="../../_modules/tdldk/v1_0/fetchers/gausers_fetcher.html#GAUsersFetcher"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#tdldk.v1_0.fetchers.GAUsersFetcher" title="Permalink to this definition">¶</a></dt>
<dd><p>Represents a GAUsers fetcher</p>
<p class="rubric">Notes</p>
<p>This fetcher enables to fetch GAUser objects.</p>
<dl class="docutils">
<dt>See:</dt>
<dd>bambou.NURESTFetcher</dd>
</dl>
</dd></dl>

<div class="section" id="methods">
<h2>Methods<a class="headerlink" href="#methods" title="Permalink to this headline">¶</a></h2>
<blockquote>
<div><dl class="classmethod">
<dt id="tdldk.v1_0.fetchers.GAUsersFetcher.managed_class">
<em class="property">classmethod </em><code class="descclassname">GAUsersFetcher.</code><code class="descname">managed_class</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/tdldk/v1_0/fetchers/gausers_fetcher.html#GAUsersFetcher.managed_class"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#tdldk.v1_0.fetchers.GAUsersFetcher.managed_class" title="Permalink to this definition">¶</a></dt>
<dd><p>Return GAUser class that is managed.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">the managed class</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="models.gauser.html#tdldk.v1_0.GAUser" title="tdldk.v1_0.GAUser">GAUser</a></td>
</tr>
</tbody>
</table>
</dd></dl>

</div></blockquote>
</div>
<div class="section" id="inherited-properties">
<h2>Inherited Properties<a class="headerlink" href="#inherited-properties" title="Permalink to this headline">¶</a></h2>
<blockquote>
<div><dl class="attribute">
<dt id="tdldk.v1_0.fetchers.GAUsersFetcher.parent_object">
<code class="descclassname">GAUsersFetcher.</code><code class="descname">parent_object</code><a class="headerlink" href="#tdldk.v1_0.fetchers.GAUsersFetcher.parent_object" title="Permalink to this definition">¶</a></dt>
<dd><p>Get served object</p>
<p>The fetcher will fill the served object with fetched objects</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">Returns the object it is serving.</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="attribute">
<dt id="tdldk.v1_0.fetchers.GAUsersFetcher.relationship">
<code class="descclassname">GAUsersFetcher.</code><code class="descname">relationship</code><a class="headerlink" href="#tdldk.v1_0.fetchers.GAUsersFetcher.relationship" title="Permalink to this definition">¶</a></dt>
<dd><p>Get relationship of the fetcher&#8217;s owner and the fetched objects</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">Returns the relationship.</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="attribute">
<dt id="tdldk.v1_0.fetchers.GAUsersFetcher.transaction_id">
<code class="descclassname">GAUsersFetcher.</code><code class="descname">transaction_id</code><a class="headerlink" href="#tdldk.v1_0.fetchers.GAUsersFetcher.transaction_id" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the transaction ID of the current connection</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">the transaction id</td>
</tr>
</tbody>
</table>
</dd></dl>

</div></blockquote>
</div>
<div class="section" id="inherited-methods">
<h2>Inherited Methods<a class="headerlink" href="#inherited-methods" title="Permalink to this headline">¶</a></h2>
<blockquote>
<div><dl class="method">
<dt id="tdldk.v1_0.fetchers.GAUsersFetcher.count">
<code class="descclassname">GAUsersFetcher.</code><code class="descname">count</code><span class="sig-paren">(</span><em>filter=None</em>, <em>order_by=None</em>, <em>group_by=[]</em>, <em>page=None</em>, <em>page_size=None</em>, <em>query_parameters=None</em>, <em>async=False</em>, <em>callback=None</em><span class="sig-paren">)</span><a class="headerlink" href="#tdldk.v1_0.fetchers.GAUsersFetcher.count" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the total count of objects that can be fetched according to filter</p>
<p>This method can be asynchronous and trigger the callback method
when result is ready.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>filter</strong> (<em>string</em>) &#8211; string that represents a predicate fitler (eg. name == &#8216;x&#8217;)</li>
<li><strong>order_by</strong> (<em>string</em>) &#8211; string that represents an order by clause</li>
<li><strong>group_by</strong> (<em>string</em>) &#8211; list of names for grouping</li>
<li><strong>page</strong> (<em>int</em>) &#8211; number of the page to load</li>
<li><strong>page_size</strong> (<em>int</em>) &#8211; number of results per page</li>
<li><strong>callback</strong> (<em>function</em>) &#8211; Method that will be triggered asynchronously</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">Returns a transaction ID when asynchronous call is made.
Otherwise it will return a tuple of information containing
(fetcher, served object, count of fetched objects)</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="tdldk.v1_0.fetchers.GAUsersFetcher.fetch">
<code class="descclassname">GAUsersFetcher.</code><code class="descname">fetch</code><span class="sig-paren">(</span><em>filter=None</em>, <em>order_by=None</em>, <em>group_by=[]</em>, <em>page=None</em>, <em>page_size=None</em>, <em>query_parameters=None</em>, <em>commit=True</em>, <em>async=False</em>, <em>callback=None</em><span class="sig-paren">)</span><a class="headerlink" href="#tdldk.v1_0.fetchers.GAUsersFetcher.fetch" title="Permalink to this definition">¶</a></dt>
<dd><p>Fetch objects according to given filter and page.</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">This method fetches all managed class objects and store them
in local_name of the served object. which means that the parent
object will hold them in a list. You can prevent this behavior
by setting commit to False. In that case, the fetched children
won&#8217;t be added in the parent object cache.</p>
</div>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>filter</strong> (<em>string</em>) &#8211; string that represents a predicate filter</li>
<li><strong>order_by</strong> (<em>string</em>) &#8211; string that represents an order by clause</li>
<li><strong>group_by</strong> (<em>string</em>) &#8211; list of names for grouping</li>
<li><strong>page</strong> (<em>int</em>) &#8211; number of the page to load</li>
<li><strong>page_size</strong> (<em>int</em>) &#8211; number of results per page</li>
<li><strong>commit</strong> (<em>bool</em>) &#8211; boolean to update current object</li>
<li><strong>callback</strong> (<em>function</em>) &#8211; Callback that should be called in case of a async request</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">Returns a tuple of information (fetcher, served object, fetched objects, connection)</p>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">tuple</p>
</td>
</tr>
</tbody>
</table>
<p class="rubric">Example</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">&gt;&gt;&gt; </span><span class="n">entity</span><span class="o">.</span><span class="n">children</span><span class="o">.</span><span class="n">fetch</span><span class="p">()</span>
<span class="go">(&lt;NUChildrenFetcher at aaaa&gt;, &lt;NUEntity at bbbb&gt;, [&lt;NUChildren at ccc&gt;, &lt;NUChildren at ddd&gt;], &lt;NURESTConnection at zzz&gt;)</span>
</pre></div>
</div>
</dd></dl>

<dl class="method">
<dt id="tdldk.v1_0.fetchers.GAUsersFetcher.fetcher_with_object">
<code class="descclassname">GAUsersFetcher.</code><code class="descname">fetcher_with_object</code><span class="sig-paren">(</span><em>parent_object</em>, <em>relationship='child'</em><span class="sig-paren">)</span><a class="headerlink" href="#tdldk.v1_0.fetchers.GAUsersFetcher.fetcher_with_object" title="Permalink to this definition">¶</a></dt>
<dd><p>Register the fetcher for a served object.</p>
<p>This method will fill the fetcher with <cite>managed_class</cite> instances</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>parent_object</strong> &#8211; the instance of the parent object to serve</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">It returns the fetcher instance.</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="tdldk.v1_0.fetchers.GAUsersFetcher.flush">
<code class="descclassname">GAUsersFetcher.</code><code class="descname">flush</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#tdldk.v1_0.fetchers.GAUsersFetcher.flush" title="Permalink to this definition">¶</a></dt>
<dd><p>Removes all fetched objects</p>
<p>It will clear attribute of the served object</p>
</dd></dl>

<dl class="method">
<dt id="tdldk.v1_0.fetchers.GAUsersFetcher.get">
<code class="descclassname">GAUsersFetcher.</code><code class="descname">get</code><span class="sig-paren">(</span><em>filter=None</em>, <em>order_by=None</em>, <em>group_by=[]</em>, <em>page=None</em>, <em>page_size=None</em>, <em>query_parameters=None</em>, <em>commit=True</em>, <em>async=False</em>, <em>callback=None</em><span class="sig-paren">)</span><a class="headerlink" href="#tdldk.v1_0.fetchers.GAUsersFetcher.get" title="Permalink to this definition">¶</a></dt>
<dd><p>Fetch object and directly return them</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last"><cite>get</cite> won&#8217;t put the fetched objects in the parent&#8217;s children list.
You cannot override this behavior. If you want to commit them in the parent
you can use :method:vsdk.NURESTFetcher.fetch or manually add the list with
:method:vsdk.NURESTObject.add_child</p>
</div>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>filter</strong> (<em>string</em>) &#8211; string that represents a predicate filter</li>
<li><strong>order_by</strong> (<em>string</em>) &#8211; string that represents an order by clause</li>
<li><strong>group_by</strong> (<em>string</em>) &#8211; list of names for grouping</li>
<li><strong>page</strong> (<em>int</em>) &#8211; number of the page to load</li>
<li><strong>page_size</strong> (<em>int</em>) &#8211; number of results per page</li>
<li><strong>commit</strong> (<em>bool</em>) &#8211; boolean to update current object</li>
<li><strong>callback</strong> (<em>function</em>) &#8211; Callback that should be called in case of a async request</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">list of vsdk.NURESTObject if any</p>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">list</p>
</td>
</tr>
</tbody>
</table>
<p class="rubric">Example</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">&gt;&gt;&gt; </span><span class="k">print</span> <span class="n">entity</span><span class="o">.</span><span class="n">children</span><span class="o">.</span><span class="n">get</span><span class="p">()</span>
<span class="go">[&lt;NUChildren at xxx&gt;, &lt;NUChildren at yyyy&gt;, &lt;NUChildren at zzz&gt;]</span>
</pre></div>
</div>
</dd></dl>

<dl class="method">
<dt id="tdldk.v1_0.fetchers.GAUsersFetcher.get_count">
<code class="descclassname">GAUsersFetcher.</code><code class="descname">get_count</code><span class="sig-paren">(</span><em>filter=None</em>, <em>order_by=None</em>, <em>group_by=[]</em>, <em>page=None</em>, <em>page_size=None</em>, <em>query_parameters=None</em><span class="sig-paren">)</span><a class="headerlink" href="#tdldk.v1_0.fetchers.GAUsersFetcher.get_count" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the total count of objects that can be fetched according to filter</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>filter</strong> (<em>string</em>) &#8211; string that represents a predicate fitler (eg. name == &#8216;x&#8217;)</li>
<li><strong>order_by</strong> (<em>string</em>) &#8211; string that represents an order by clause</li>
<li><strong>group_by</strong> (<em>string</em>) &#8211; list of names for grouping</li>
<li><strong>page</strong> (<em>int</em>) &#8211; number of the page to load</li>
<li><strong>page_size</strong> (<em>int</em>) &#8211; number of results per page</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">Returns the number of objects found</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="tdldk.v1_0.fetchers.GAUsersFetcher.get_first">
<code class="descclassname">GAUsersFetcher.</code><code class="descname">get_first</code><span class="sig-paren">(</span><em>filter=None</em>, <em>order_by=None</em>, <em>group_by=[]</em>, <em>query_parameters=None</em>, <em>commit=False</em>, <em>async=False</em>, <em>callback=None</em><span class="sig-paren">)</span><a class="headerlink" href="#tdldk.v1_0.fetchers.GAUsersFetcher.get_first" title="Permalink to this definition">¶</a></dt>
<dd><p>Fetch object and directly return the first one</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last"><cite>get_first</cite> won&#8217;t put the fetched object in the parent&#8217;s children list.
You cannot override this behavior. If you want to commit it in the parent
you can use :method:vsdk.NURESTFetcher.fetch or manually add it with
:method:vsdk.NURESTObject.add_child</p>
</div>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>filter</strong> (<em>string</em>) &#8211; string that represents a predicate filter</li>
<li><strong>order_by</strong> (<em>string</em>) &#8211; string that represents an order by clause</li>
<li><strong>group_by</strong> (<em>string</em>) &#8211; list of names for grouping</li>
<li><strong>page</strong> (<em>int</em>) &#8211; number of the page to load</li>
<li><strong>page_size</strong> (<em>int</em>) &#8211; number of results per page</li>
<li><strong>commit</strong> (<em>bool</em>) &#8211; boolean to update current object</li>
<li><strong>callback</strong> (<em>function</em>) &#8211; Callback that should be called in case of a async request</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">the first object if any, or None</p>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">vsdk.NURESTObject</p>
</td>
</tr>
</tbody>
</table>
<p class="rubric">Example</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">&gt;&gt;&gt; </span><span class="k">print</span> <span class="n">entity</span><span class="o">.</span><span class="n">children</span><span class="o">.</span><span class="n">get_first</span><span class="p">(</span><span class="nb">filter</span><span class="o">=</span><span class="s">&quot;name == &#39;My Entity&#39;&quot;</span><span class="p">)</span>
<span class="go">&lt;NUChildren at xxx&gt;</span>
</pre></div>
</div>
</dd></dl>

<dl class="method">
<dt id="tdldk.v1_0.fetchers.GAUsersFetcher.index">
<code class="descclassname">GAUsersFetcher.</code><code class="descname">index</code><span class="sig-paren">(</span><em>nurest_object</em><span class="sig-paren">)</span><a class="headerlink" href="#tdldk.v1_0.fetchers.GAUsersFetcher.index" title="Permalink to this definition">¶</a></dt>
<dd><p>Get index of the given item
:param nurest_object: the NURESTObject object to verify</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">Returns the position of the object.</td>
</tr>
<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><strong>Raise a ValueError exception if object is not present</strong> &#8211;</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="tdldk.v1_0.fetchers.GAUsersFetcher.managed_object_rest_name">
<code class="descclassname">GAUsersFetcher.</code><code class="descname">managed_object_rest_name</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#tdldk.v1_0.fetchers.GAUsersFetcher.managed_object_rest_name" title="Permalink to this definition">¶</a></dt>
<dd><p>Remote name of the managed object</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">Returns a string representing the resource name of the object
that has to be fetched.</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="tdldk.v1_0.fetchers.GAUsersFetcher.new">
<code class="descclassname">GAUsersFetcher.</code><code class="descname">new</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#tdldk.v1_0.fetchers.GAUsersFetcher.new" title="Permalink to this definition">¶</a></dt>
<dd><p>Create an instance of the managed class</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">Returns an instance of managed_class</td>
</tr>
</tbody>
</table>
</dd></dl>

</div></blockquote>
</div>
</div>


          </div>
          <footer>
  
    <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
      
        <a href="../../bambou_reference.html" class="btn btn-neutral float-right" title="Bambou API Reference" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
      
      
        <a href="fetchers.gatasksfetcher.html" class="btn btn-neutral" title="GATasksFetcher" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>
      
    </div>
  

  <hr/>

  <div role="contentinfo">
    <p>
        &copy; Copyright Copyright (c) 2015, Nuage Networks.
    </p>
  </div>
  Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.

</footer>

        </div>
      </div>

    </section>

  </div>
  


  

    <script type="text/javascript">
        var DOCUMENTATION_OPTIONS = {
            URL_ROOT:'../../',
            VERSION:'',
            COLLAPSE_INDEX:false,
            FILE_SUFFIX:'.html',
            HAS_SOURCE:  true
        };
    </script>
      <script type="text/javascript" src="../../_static/jquery.js"></script>
      <script type="text/javascript" src="../../_static/underscore.js"></script>
      <script type="text/javascript" src="../../_static/doctools.js"></script>

  

  
  
    <script type="text/javascript" src="../../_static/js/theme.js"></script>
  

  
  
  <script type="text/javascript">
      jQuery(function () {
          SphinxRtdTheme.StickyNav.enable();
      });
  </script>
   

</body>
</html>